docs: use the dynamic README header endpoint - #17
Open
AlemTuzlak wants to merge 2 commits into
Open
Conversation
📝 WalkthroughWalkthroughThe README files now use responsive TanStack Workflow banners with separate dark and light image sources. Template package READMEs also document their leftover scaffolding status. ChangesREADME theme-aware banners
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
🚀 Changeset Version Preview2 package(s) bumped directly, 6 bumped as dependents. 🟩 Patch bumps
|
More templates
@tanstack/react-template
@tanstack/react-template-devtools
@tanstack/solid-template
@tanstack/solid-template-devtools
@tanstack/template
@tanstack/template-devtools
@tanstack/workflow-cloudflare
@tanstack/workflow-core
@tanstack/workflow-netlify
@tanstack/workflow-railway
@tanstack/workflow-runtime
@tanstack/workflow-store-cloudflare-d1
@tanstack/workflow-store-drizzle-postgres
@tanstack/workflow-vercel
commit: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adopts the dynamic README header endpoint added in TanStack/tanstack.com#1076,
which is merged and live.
README banners now point a
<picture>athttps://tanstack.com/api/readme/instead of a committed PNG. The endpoint renders 1800x450 in light and dark, so
a branding change lands in every README at once and dark-mode readers get a
dark banner.
What changed
README.mdhad no banner at all. It gets one now, for parity with the other library repos.packages/template*(6 READMEs) pointed at./media/header_template.png. This repo has nomedia/directory, so those banners were broken. They now point at the endpoint.Known limitation, deliberately not fixed here
The six
packages/template*packages (@tanstack/template,@tanstack/react-template,@tanstack/solid-templateand their devtools) are leftover scaffolding fromTanStack/template, not real Workflow packages:pnpm-workspace.yaml, so never installed, built, linted or typechecked0.0.0@tanstack/workflow-core, which is published)packages/template/src/hello.tsis the untouched template placeholderThe same is true of
examples/react/*andexamples/solid/*, which import them.This PR only stops the images being broken - it does not remove the dead code.
Each of those six READMEs carries an HTML comment saying so, so the next person
who opens one is not misled. Removing the scaffolding is ~78 files across 10
directories plus one
@tanstack/react-templatebadge in.github/ISSUE_TEMPLATE/bug_report.yml; nothing else references any of it, so itwould be a self-contained cleanup whenever you want it.
Notes
<picture>, per GitHub's guidance. The trailing<img>stays the light variant, as the fallback for renderers that ignore<picture>(npm, most editors).workflowaccepts no?framework=values on the site, so every banner here is the plain library banner.Verification
All 21 URL occurrences across the 7 READMEs resolve to 2 distinct URLs, both
returning
200 image/pngat 1800x450.git grepconfirms no README stillreferences the missing
media/header_template.png.Summary by CodeRabbit